docs/zh/platform/h5.md (2)

22-22: Replace hard tabs with spaces.

For consistency in markdown files, replace hard tabs with spaces.

-│		├── scene.json # 场景文件
+│   ├── scene.json # 场景文件

🧰 Tools

🪛 Markdownlint (0.37.0)

22-22: Column: 2
Hard tabs

(MD010, no-hard-tabs)

---

16-16: Add alt text to images for accessibility.

Images should include descriptive alt text. For example:

-<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*jINgTIhAuDgAAAAAAAAAAAAADjCHAQ/fmt.webp" />
+<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*jINgTIhAuDgAAAAAAAAAAAAADjCHAQ/fmt.webp" alt="H5 platform export panel" />

Also applies to: 50-50, 54-54

docs/zh/platform/wechatMiniGame.md (1)

14-21: Standardize table formatting.

For consistency:

1. Use leading-only pipe style
2. Add blank lines around tables

Example fix for the first table:

+
| 配置 | 描述 | 对应到微信小游戏的配置文件 | 对应到微信小游戏中的字段 |
| --- | --- | --- | --- |
| AppId | 微信小游戏的 AppId，必填，截图中的 wxdf8199565c509fb9 为测试账号 | project.config.json | appid |
+

Also applies to: 64-74

🧰 Tools

🪛 Markdownlint (0.37.0)

15-15: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

16-16: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

17-17: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

18-18: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

19-19: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

20-20: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

21-21: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

docs/zh/platform/platform.md (2)

8-8: Fix grammatical issue in Chinese text.

Correct the modifier usage:

-开发者通过编辑器制作的项目，可以快速的导出到不同的平台所需的工程。
+开发者通过编辑器制作的项目，可以快速地导出到不同的平台所需的工程。

🧰 Tools

🪛 LanguageTool

[uncategorized] ~8-~8: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：快速"地"导出
Context: ...acean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目，可以快速的导出到不同的平台所需的工程。 ## 前置准备 项目在编辑器中开发完成后，就可以...

(wb4)

---

18-18: Add alt text to images for accessibility.

Add descriptive alt text to images. For example:

-<img src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*U2RuQLwwNXIAAAAAAAAAAAAADjCHAQ/fmt.webp" />
+<img src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*U2RuQLwwNXIAAAAAAAAAAAAADjCHAQ/fmt.webp" alt="Export button location in editor" />

Also applies to: 22-22, 26-26

🧰 Tools

🪛 Markdownlint (0.37.0)

18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

docs/en/platform/wechatMiniGame.md (1)

63-74: Use proper heading instead of bold text.

The directory explanation section uses bold text instead of a proper heading level. Convert it to a heading for better document structure.

-**工程目录说明**
+### Project Directory Structure

🧰 Tools

🪛 Markdownlint (0.37.0)

63-63: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

64-64: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

65-65: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

66-66: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

67-67: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

68-68: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

69-69: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

70-70: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

71-71: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

72-72: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

73-73: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

74-74: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

64-64: null
Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

docs/en/platform/h5.md (1)

22-22: Replace hard tab with spaces in directory structure.

The directory structure uses a hard tab which should be replaced with spaces for consistent formatting.

-│		├── scene.json # 场景文件
+│   ├── scene.json # Scene file

🧰 Tools

🪛 Markdownlint (0.37.0)

22-22: Column: 2
Hard tabs

(MD010, no-hard-tabs)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

docs/en/core/canvas.md (1)

Line range hint 1-100: Consider maintaining consistent language usage throughout the documentation.

The documentation contains mixed language usage (English and Chinese), particularly in code comments and explanations. Since this is in the docs/en/ directory, consider translating all content to English for consistency.

docs/en/graphics/2D/spine/runtime.md (5)

11-21: Consider adding version compatibility information.

While the installation instructions are clear, it would be helpful to specify:

• Supported versions of the Spine runtime
• Version compatibility matrix with the Galacean engine

---

60-63: Use a more realistic example URL.

The current placeholder URL 'galacean.raptor.json' might be confusing. Consider using a more realistic example that follows common URL patterns.

-  url: 'https://galacean.raptor.json', // Or the relative file path, e.g., '../public/raptor.json"'
+  url: 'https://assets.example.com/spine/raptor/raptor.json', // Or the relative file path, e.g., '../public/raptor.json"'

---

78-82: Add error handling for resource loading.

The example should demonstrate proper error handling for common failure scenarios such as:

• Network errors
• Invalid or missing resources
• Malformed spine data

-const resource = await engine.resourceManager.load({
-  url: 'https://your.spineboy.json', // Custom uploaded asset
-  type: 'spine', // The loader type must be specified as 'spine'
-});
+try {
+  const resource = await engine.resourceManager.load({
+    url: 'https://your.spineboy.json', // Custom uploaded asset
+    type: 'spine', // The loader type must be specified as 'spine'
+  });
+} catch (error) {
+  console.error('Failed to load Spine resource:', error);
+  // Handle specific error cases
+  if (error.name === 'NetworkError') {
+    // Handle network errors
+  } else if (error.name === 'ResourceNotFoundError') {
+    // Handle missing resources
+  }
+}

---

382-399: Add security considerations for attachment replacement.

When replacing attachments at runtime, consider adding security guidelines:

• Validate attachment sources
• Implement size limits for custom attachments
• Document potential performance impacts

---

85-85: Minor markdown formatting improvements.

Consider these formatting enhancements:

• Wrap bare URLs in proper markdown link syntax
• Use proper heading syntax (##) instead of bold text for sections

Also applies to: 102-102, 403-403, 421-421

🧰 Tools

🪛 Markdownlint (0.37.0)

85-85: null
Bare URL used

(MD034, no-bare-urls)

---

85-85: null
Bare URL used

(MD034, no-bare-urls)

---

85-85: null
Bare URL used

(MD034, no-bare-urls)

docs/en/platform/h5.md (4)

10-10: Improve sentence clarity.

The sentence structure could be improved for better readability.

-When exporting to the H5 platform, there is no additional platform-related export configuration except for the general export configuration, so no configuration is required
+When exporting to the H5 platform, no additional platform-specific configuration is required beyond the general export settings.

---

21-22: Replace hard tabs with spaces in the directory structure.

Use spaces instead of hard tabs for consistent formatting in markdown.

-├── public # 📁 Public resource directory
-│		├── scene.json # Scene File
+├── public # 📁 Public resource directory
+│   ├── scene.json # Scene File

🧰 Tools

🪛 Markdownlint (0.37.0)

22-22: Column: 2
Hard tabs

(MD010, no-hard-tabs)

---

35-35: Improve the remark's professional tone.

The remark about framework compatibility could be more professionally worded.

-**Remark:** Because React/Vue/Vanilla JS all belong to the H5 platform and are similar, the document is explained in React.
+**Note:** Since React, Vue, and Vanilla JS are all part of the H5 platform and share similar characteristics, this documentation uses React for illustration purposes.

---

39-41: Standardize formatting in the debug section.

1. Use standard numbering format instead of Chinese numerals
2. Use consistent command separators

-1、Enter the root directory of the exported project and execute the installation command as follows:
-npm i 或者 pnpm i
+1. Enter the root directory of the exported project and execute the installation command as follows:
+npm i || pnpm i

docs/en/platform/wechatMiniGame.md (2)

12-12: Add alt text to images for accessibility.

Images should include descriptive alt text for better accessibility.

Example fix for the first image:

-<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*natiS7i3cvUAAAAAAAAAAAAADjCHAQ/fmt.webp" />
+<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*natiS7i3cvUAAAAAAAAAAAAADjCHAQ/fmt.webp" alt="WeChat Mini Game configuration panel" />

Also applies to: 29-29, 41-41, 49-49, 54-54, 61-61

---

14-21: Standardize table formatting.

Tables should use consistent pipe styles and be surrounded by blank lines.

Example fix for the configuration table:

| Configuration | Description | WeChat Mini Game Config File | Field |
| ------------ | ----------- | ---------------------------- | ----- |
| AppId | AppId of WeChat Mini Game (required) | project.config.json | appid |

Also applies to: 64-74

🧰 Tools

🪛 Markdownlint (0.37.0)

15-15: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

16-16: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

17-17: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

18-18: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

19-19: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

20-20: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

---

21-21: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

docs/en/platform/platform.md (1)

40-40: Format technical terms consistently.

Technical terms like WebGL versions should be formatted consistently.

-| WebGL Mode | Select the version to use with WebGL:<br> **Auto：** WebGL2.0 is preferred. If the operating environment does not support it, it will automatically switch to WebGL1.0 <br> **WebGL1.0：** Using WebGL1.0 <br>  **WebGL2.0：**  Using WebGL2.0
+| WebGL Mode | Select the version to use with WebGL:<br> **Auto:** `WebGL 2.0` is preferred. If the operating environment does not support it, it will automatically switch to `WebGL 1.0` <br> **WebGL 1.0:** Using `WebGL 1.0` <br> **WebGL 2.0:** Using `WebGL 2.0`

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro